Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add README documentation for getting started #9

Merged
merged 1 commit into from
Oct 1, 2023
Merged

Conversation

j-chad
Copy link
Owner

@j-chad j-chad commented Oct 1, 2023

Description

Adds a README describing the planned features and how to develop locally

Checklist

  • I have tested my changes locally and they work as expected.
  • I have documented any new or modified functionality in the project documentation.
  • I have added appropriate comments to the code, especially in complex or non-obvious sections.
  • All existing tests pass successfully with my changes.

@j-chad j-chad marked this pull request as ready for review October 1, 2023 00:08
@j-chad j-chad merged commit b3e3449 into main Oct 1, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant